<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-guide.qdoc -->
  <title>Getting Started with QDoc | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Getting Started with QDoc</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="next" href="qdoc-guide-clang.html" />
<p class="naviNextPrevious headerNavi">
<a class="nextPage" href="qdoc-guide-clang.html">Installing Clang for QDoc</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#chapters">Chapters</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Getting Started with QDoc</h1>
<span class="subtitle"></span>
<!-- $$$qdoc-guide.html-description -->
<div class="descr"> <a name="details"></a>
<p>Qt uses QDoc to generate its documentation set into HTML and DITA XML formats. QDoc uses a set of configuration files to generate documentation from QDoc comments. The comments have types called <a href="qdoc-guide-writing.html#writing-topic-commands">topics</a> that determine whether a comment is a class documentation or a property documentation. A comment may also have <a href="qdoc-guide-writing.html#writing-markup">mark up</a> to enhance the layout and formatting of the final output.</p>
<p>There are three essential materials for generating documentation with qdoc:</p>
<ul>
<li><code>QDoc</code> binary</li>
<li><code>qdocconf</code> configuration files</li>
<li><code>Documentation</code> in <code>C++</code>, <code>QML</code>, and <code>.qdoc</code> files</li>
</ul>
<p><b>Note: </b>From Qt 5.11, <a href="qdoc-index.html">QDoc</a> requires <a href="http://clang.llvm.org">Clang</a> for parsing C++ header and source files, and for parsing the function signatures in <a href="13-qdoc-commands-topics.html#fn-command">\fn</a> commands. See <a href="qdoc-guide-clang.html">Installing Clang for QDoc</a> for details.</p><p>This section intends to cover the basic necessities for creating a documentation set. Additionally, the guide presents special considerations and options to documenting non-C++ API documentation as well as QML documentation. Finally, the guide will provide a sample project documentation and an example of a QML type documentation.</p>
<p>For specific QDoc information, consult the <a href="qdoc-index.html">QDoc Manual</a>.</p>
<a name="chapters"></a>
<h2 id="chapters">Chapters</h2>
<ol class="1" type="1"><li><a href="qdoc-guide-clang.html">Installing Clang for QDoc</a></li>
<li><a href="qdoc-guide-conf.html">Creating QDoc Configuration Files</a></li>
<li><a href="qdoc-guide-writing.html">Writing Documentation</a></li>
<li><a href="qdoc-categories.html">Categories of Documentation</a><ul>
<li><a href="qtwritingstyle-cpp.html">C++ Documentation Style</a></li>
<li><a href="qtwritingstyle-qml.html">QML Documentation Style</a></li>
</ul>
</li>
</ol>
</div>
<!-- @@@qdoc-guide.html -->
<p class="naviNextPrevious footerNavi">
<a class="nextPage" href="qdoc-guide-clang.html">Installing Clang for QDoc</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
